/*
 * Copyright (c) 2010-2011 Plugger Antonio Begue Ponce. All Rights Reserved.
 *
 * This file is part of Plugger Framework.
 *
 *  Plugger Framework is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License version 3 as published by
 *  the Free Software Foundation.
 *
 *  Plugger Framework is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with Plugger Framework.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.plugger.infrastructure.rules;

import java.util.Map;

/**
 * Definition of a broken rule messages manager.
 *
 * @author Antonio Begue
 * @version $Revision: 1.0 $
 */
public interface IBrokenRuleMessages {
    /**
     * Represent a collection of messages.
     * @return Map of messages.
     */
    Map<String, String> getMessages();

    /**
     * A function to fill the Messages list.
     */
    void populateMessages();

    /**
     * Associate the ruleId with the rule message.
     * @param key Rule Id.
     * @param value Rule Message.
     */
    void addMessage(String key, String value);

    /**
     * Return the message to witch the rule id is mapped
     * @param messageKey Rule Id.
     * @return Rule Message.
     */
    String getRuleDescription(String messageKey);
}
